<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Appendix B. Zend Framework Coding Standard for PHP</title>
<link rel="stylesheet" href="dbstyle.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.72.0">
<link rel="start" href="index.html" title="Programmer's Reference Guide">
<link rel="up" href="index.html" title="Programmer's Reference Guide">
<link rel="prev" href="requirements.dependencies.html" title="A.4. Zend Framework Dependencies">
<link rel="next" href="coding-standard.php-file-formatting.html" title="B.2. PHP File Formatting">
<link rel="chapter" href="introduction.html" title="Chapter 1. Introduction to Zend Framework">
<link rel="chapter" href="zend.acl.html" title="Chapter 2. Zend_Acl">
<link rel="chapter" href="zend.auth.html" title="Chapter 3. Zend_Auth">
<link rel="chapter" href="zend.cache.html" title="Chapter 4. Zend_Cache">
<link rel="chapter" href="zend.config.html" title="Chapter 5. Zend_Config">
<link rel="chapter" href="zend.console.getopt.html" title="Chapter 6. Zend_Console_Getopt">
<link rel="chapter" href="zend.controller.html" title="Chapter 7. Zend_Controller">
<link rel="chapter" href="zend.currency.html" title="Chapter 8. Zend_Currency">
<link rel="chapter" href="zend.date.html" title="Chapter 9. Zend_Date">
<link rel="chapter" href="zend.db.html" title="Chapter 10. Zend_Db">
<link rel="chapter" href="zend.debug.html" title="Chapter 11. Zend_Debug">
<link rel="chapter" href="zend.dojo.html" title="Chapter 12. Zend_Dojo">
<link rel="chapter" href="zend.dom.html" title="Chapter 13. Zend_Dom">
<link rel="chapter" href="zend.exception.html" title="Chapter 14. Zend_Exception">
<link rel="chapter" href="zend.feed.html" title="Chapter 15. Zend_Feed">
<link rel="chapter" href="zend.filter.html" title="Chapter 16. Zend_Filter">
<link rel="chapter" href="zend.form.html" title="Chapter 17. Zend_Form">
<link rel="chapter" href="zend.gdata.html" title="Chapter 18. Zend_Gdata">
<link rel="chapter" href="zend.http.html" title="Chapter 19. Zend_Http">
<link rel="chapter" href="zend.infocard.html" title="Chapter 20. Zend_InfoCard">
<link rel="chapter" href="zend.json.html" title="Chapter 21. Zend_Json">
<link rel="chapter" href="zend.layout.html" title="Chapter 22. Zend_Layout">
<link rel="chapter" href="zend.ldap.html" title="Chapter 23. Zend_Ldap">
<link rel="chapter" href="zend.loader.html" title="Chapter 24. Zend_Loader">
<link rel="chapter" href="zend.locale.html" title="Chapter 25. Zend_Locale">
<link rel="chapter" href="zend.log.html" title="Chapter 26. Zend_Log">
<link rel="chapter" href="zend.mail.html" title="Chapter 27. Zend_Mail">
<link rel="chapter" href="zend.measure.html" title="Chapter 28. Zend_Measure">
<link rel="chapter" href="zend.memory.html" title="Chapter 29. Zend_Memory">
<link rel="chapter" href="zend.mime.html" title="Chapter 30. Zend_Mime">
<link rel="chapter" href="zend.openid.html" title="Chapter 31. Zend_OpenId">
<link rel="chapter" href="zend.paginator.html" title="Chapter 32. Zend_Paginator">
<link rel="chapter" href="zend.pdf.html" title="Chapter 33. Zend_Pdf">
<link rel="chapter" href="zend.registry.html" title="Chapter 34. Zend_Registry">
<link rel="chapter" href="zend.rest.html" title="Chapter 35. Zend_Rest">
<link rel="chapter" href="zend.search.lucene.html" title="Chapter 36. Zend_Search_Lucene">
<link rel="chapter" href="zend.server.html" title="Chapter 37. Zend_Server">
<link rel="chapter" href="zend.service.html" title="Chapter 38. Zend_Service">
<link rel="chapter" href="zend.session.html" title="Chapter 39. Zend_Session">
<link rel="chapter" href="zend.soap.html" title="Chapter 40. Zend_Soap">
<link rel="chapter" href="zend.test.html" title="Chapter 41. Zend_Test">
<link rel="chapter" href="zend.text.html" title="Chapter 42. Zend_Text">
<link rel="chapter" href="zend.timesync.html" title="Chapter 43. Zend_TimeSync">
<link rel="chapter" href="zend.translate.html" title="Chapter 44. Zend_Translate">
<link rel="chapter" href="zend.uri.html" title="Chapter 45. Zend_Uri">
<link rel="chapter" href="zend.validate.html" title="Chapter 46. Zend_Validate">
<link rel="chapter" href="zend.version.html" title="Chapter 47. Zend_Version">
<link rel="chapter" href="zend.view.html" title="Chapter 48. Zend_View">
<link rel="chapter" href="zend.xmlrpc.html" title="Chapter 49. Zend_XmlRpc">
<link rel="appendix" href="requirements.html" title="Appendix A. Zend Framework Requirements">
<link rel="appendix" href="coding-standard.html" title="Appendix B. Zend Framework Coding Standard for PHP">
<link rel="appendix" href="copyrights.html" title="Appendix C. Copyright Information">
<link rel="index" href="the.index.html" title="Index">
<link rel="section" href="coding-standard.html#coding-standard.overview" title="B.1. Overview">
<link rel="section" href="coding-standard.php-file-formatting.html" title="B.2. PHP File Formatting">
<link rel="section" href="coding-standard.naming-conventions.html" title="B.3. Naming Conventions">
<link rel="section" href="coding-standard.coding-style.html" title="B.4. Coding Style">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<div class="navheader"><table width="100%" summary="Navigation header">
<tr><th colspan="3" align="center">Appendix B. Zend Framework Coding Standard for PHP</th></tr>
<tr>
<td width="20%" align="left">
<a accesskey="p" href="requirements.dependencies.html">Prev</a> </td>
<th width="60%" align="center"> </th>
<td width="20%" align="right"> <a accesskey="n" href="coding-standard.php-file-formatting.html">Next</a>
</td>
</tr>
</table></div>
<div class="appendix" lang="en">
<div class="titlepage"><div><div><h2 class="title">
<a name="coding-standard"></a>Appendix B. Zend Framework Coding Standard for PHP</h2></div></div></div>
<div class="toc">
<p><b>Table of Contents</b></p>
<dl>
<dt><span class="sect1"><a href="coding-standard.html#coding-standard.overview">B.1. Overview</a></span></dt>
<dd><dl>
<dt><span class="sect2"><a href="coding-standard.html#coding-standard.overview.scope">B.1.1. Scope</a></span></dt>
<dt><span class="sect2"><a href="coding-standard.html#coding-standard.overview.goals">B.1.2. Goals</a></span></dt>
</dl></dd>
<dt><span class="sect1"><a href="coding-standard.php-file-formatting.html">B.2. PHP File Formatting</a></span></dt>
<dd><dl>
<dt><span class="sect2"><a href="coding-standard.php-file-formatting.html#coding-standard.php-file-formatting.general">B.2.1. General</a></span></dt>
<dt><span class="sect2"><a href="coding-standard.php-file-formatting.html#coding-standard.php-file-formatting.indentation">B.2.2. Indentation</a></span></dt>
<dt><span class="sect2"><a href="coding-standard.php-file-formatting.html#coding-standard.php-file-formatting.max-line-length">B.2.3. Maximum Line Length</a></span></dt>
<dt><span class="sect2"><a href="coding-standard.php-file-formatting.html#coding-standard.php-file-formatting.line-termination">B.2.4. Line Termination</a></span></dt>
</dl></dd>
<dt><span class="sect1"><a href="coding-standard.naming-conventions.html">B.3. Naming Conventions</a></span></dt>
<dd><dl>
<dt><span class="sect2"><a href="coding-standard.naming-conventions.html#coding-standard.naming-conventions.classes">B.3.1. Classes</a></span></dt>
<dt><span class="sect2"><a href="coding-standard.naming-conventions.html#coding-standard.naming-conventions.filenames">B.3.2. Filenames</a></span></dt>
<dt><span class="sect2"><a href="coding-standard.naming-conventions.html#coding-standard.naming-conventions.functions-and-methods">B.3.3. Functions and Methods</a></span></dt>
<dt><span class="sect2"><a href="coding-standard.naming-conventions.html#coding-standard.naming-conventions.variables">B.3.4. Variables</a></span></dt>
<dt><span class="sect2"><a href="coding-standard.naming-conventions.html#coding-standard.naming-conventions.constants">B.3.5. Constants</a></span></dt>
</dl></dd>
<dt><span class="sect1"><a href="coding-standard.coding-style.html">B.4. Coding Style</a></span></dt>
<dd><dl>
<dt><span class="sect2"><a href="coding-standard.coding-style.html#coding-standard.coding-style.php-code-demarcation">B.4.1. PHP Code Demarcation</a></span></dt>
<dt><span class="sect2"><a href="coding-standard.coding-style.html#coding-standard.coding-style.strings">B.4.2. Strings</a></span></dt>
<dd><dl>
<dt><span class="sect3"><a href="coding-standard.coding-style.html#coding-standard.coding-style.strings.literals">B.4.2.1. String Literals</a></span></dt>
<dt><span class="sect3"><a href="coding-standard.coding-style.html#coding-standard.coding-style.strings.literals-containing-apostrophes">B.4.2.2. String Literals Containing Apostrophes</a></span></dt>
<dt><span class="sect3"><a href="coding-standard.coding-style.html#coding-standard.coding-style.strings.variable-substitution">B.4.2.3. Variable Substitution</a></span></dt>
<dt><span class="sect3"><a href="coding-standard.coding-style.html#coding-standard.coding-style.strings.string-concatenation">B.4.2.4. String Concatenation</a></span></dt>
</dl></dd>
<dt><span class="sect2"><a href="coding-standard.coding-style.html#coding-standard.coding-style.arrays">B.4.3. Arrays</a></span></dt>
<dd><dl>
<dt><span class="sect3"><a href="coding-standard.coding-style.html#coding-standard.coding-style.arrays.numerically-indexed">B.4.3.1. Numerically Indexed Arrays</a></span></dt>
<dt><span class="sect3"><a href="coding-standard.coding-style.html#coding-standard.coding-style.arrays.associative">B.4.3.2. Associative Arrays</a></span></dt>
</dl></dd>
<dt><span class="sect2"><a href="coding-standard.coding-style.html#coding-standard.coding-style.classes">B.4.4. Classes</a></span></dt>
<dd><dl>
<dt><span class="sect3"><a href="coding-standard.coding-style.html#coding-standard.coding-style.classes.declaration">B.4.4.1. Class Declaration</a></span></dt>
<dt><span class="sect3"><a href="coding-standard.coding-style.html#coding-standard.coding-style.classes.member-variables">B.4.4.2. Class Member Variables</a></span></dt>
</dl></dd>
<dt><span class="sect2"><a href="coding-standard.coding-style.html#coding-standard.coding-style.functions-and-methods">B.4.5. Functions and Methods</a></span></dt>
<dd><dl>
<dt><span class="sect3"><a href="coding-standard.coding-style.html#coding-standard.coding-style.functions-and-methods.declaration">B.4.5.1. Function and Method Declaration</a></span></dt>
<dt><span class="sect3"><a href="coding-standard.coding-style.html#coding-standard.coding-style.functions-and-methods.usage">B.4.5.2. Function and Method Usage</a></span></dt>
</dl></dd>
<dt><span class="sect2"><a href="coding-standard.coding-style.html#coding-standard.coding-style.control-statements">B.4.6. Control Statements</a></span></dt>
<dd><dl>
<dt><span class="sect3"><a href="coding-standard.coding-style.html#coding-standard.coding-style.control-statements.if-else-elseif">B.4.6.1. If/Else/Elseif</a></span></dt>
<dt><span class="sect3"><a href="coding-standard.coding-style.html#coding-standards.coding-style.control-statements.switch">B.4.6.2. Switch</a></span></dt>
</dl></dd>
<dt><span class="sect2"><a href="coding-standard.coding-style.html#coding-standards.inline-documentation">B.4.7. Inline Documentation</a></span></dt>
<dd><dl>
<dt><span class="sect3"><a href="coding-standard.coding-style.html#coding-standards.inline-documentation.documentation-format">B.4.7.1. Documentation Format</a></span></dt>
<dt><span class="sect3"><a href="coding-standard.coding-style.html#coding-standards.inline-documentation.files">B.4.7.2. Files</a></span></dt>
<dt><span class="sect3"><a href="coding-standard.coding-style.html#coding-standards.inline-documentation.classes">B.4.7.3. Classes</a></span></dt>
<dt><span class="sect3"><a href="coding-standard.coding-style.html#coding-standards.inline-documentation.functions">B.4.7.4. Functions</a></span></dt>
</dl></dd>
</dl></dd>
</dl>
</div>
<div class="sect1" lang="en">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="coding-standard.overview"></a>B.1. Overview</h2></div></div></div>
<div class="sect2" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="coding-standard.overview.scope"></a>B.1.1. Scope</h3></div></div></div>
<p>
                This document provides guidelines for code formatting and documentation to individuals
                and teams contributing to Zend Framework. Many developers using Zend Framework have also
                found these coding standards useful because their code's style remains consistent with all
                Zend Framework code. It is also worth noting that it requires significant effort to fully
                specify coding standards.
                
                Note: Sometimes developers consider the establishment of a standard more important than what that
                standard actually suggests at the most detailed level of design. The guidelines in the Zend Framework
                coding standards capture practices that have worked well on the ZF project. You may modify these standards
                or use them as is in accordance with the terms of our <a href="http://framework.zend.com/license" target="_top">license</a>
            </p>
<p>
                Topics covered in the ZF coding standards include:

                </p>
<div class="itemizedlist"><ul type="disc">
<li><p>PHP File Formatting</p></li>
<li><p>Naming Conventions</p></li>
<li><p>Coding Style</p></li>
<li><p>Inline Documentation</p></li>
</ul></div>
<p>
            </p>
</div>
<div class="sect2" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="coding-standard.overview.goals"></a>B.1.2. Goals</h3></div></div></div>
<p>
                Coding standards are important in any development project, but they are particularly important
                when many developers are working on the same project. Coding standards
                help ensure that the code is high quality, has fewer bugs, and can be easily maintained.
            </p>
</div>
</div>
</div>
<div class="navfooter"><table width="100%" summary="Navigation footer">
<tr>
<td width="40%" align="left">
<a accesskey="p" href="requirements.dependencies.html">Prev</a> </td>
<td width="20%" align="center"> </td>
<td width="40%" align="right"> <a accesskey="n" href="coding-standard.php-file-formatting.html">Next</a>
</td>
</tr>
<tr>
<td width="40%" align="left" valign="top">A.4. Zend Framework Dependencies </td>
<td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td>
<td width="40%" align="right" valign="top"> B.2. PHP File Formatting</td>
</tr>
</table></div>
<div class="revinfo"></div>
</body>
</html>
